銀行振込(バーチャル口座)取引口座利用 API一覧
HTTP仕様(.idPass)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
EntryTranVirtualaccount 取引登録
決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
リクエスト
ShopID | 必須 半角英数13桁
ショップID |
|
---|---|---|
ShopPass | 必須 半角英数64桁
ショップパスワード |
|
OrderID | 必須 半角英数記号27桁
オーダーID |
|
Amount | 必須 半角数字8桁
利用金額(振込依頼金額) |
|
Tax | 半角数字7桁
税送料(振込依頼金額) |
URL
/payment/EntryTranVirtualaccount.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=100
レスポンス
レスポンスパラメータ:正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001
ExecTranVirtualaccount 決済実行
振込依頼に関する情報を受け取り、バーチャル口座の口座情報を返却します。
振込依頼情報としてお客様のメールアドレスを指定すると、振込依頼メールを送信します。
(メールアドレス未指定の場合は、加盟店様からお客様に振込依頼をしてください)
リクエスト
ShopID | 必須 半角英数13桁
ショップID |
|
---|---|---|
ShopPass | 必須 半角英数64桁
ショップパスワード |
|
AccessID | 必須 半角英数32桁 固定
取引ID |
|
AccessPass | 必須 半角英数32桁 固定
取引パスワード |
|
OrderID | 必須 半角英数記号27桁
オーダーID |
|
ClientField1 | 全半角100バイト
加盟店自由項目1 |
|
ClientField2 | 全半角100バイト
加盟店自由項目2 |
|
ClientField3 | 全半角100バイト
加盟店自由項目3 |
|
TradeDays | 必須 半角数字2桁
振込有効日数 取引が有効な日数を指定してください。 |
|
TradeReason | 全半角64バイト
振込事由 |
|
TradeClientName | 全半角64バイト
振込依頼者氏名 |
|
TradeClientMailaddress | 半角英数記号256桁
振込依頼者メールアドレス |
URL
/payment/ExecTranVirtualaccount.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&TradeDays=5
レスポンス
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&BankCode=9998&BankName=テスト銀行&BranchCode=999&BranchName=テスト支店&AccountType=1&AccountNumber=1119999&AvailableDate=20220801&TradeCode=TEST
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001
SearchTradeMulti 取引状態参照
指定したオーダーIDの取引情報を取得します。
レスポンス
正常
Status | 半角英字11桁
現状態 UNPROCESSED:未決済 |
|
---|---|---|
ProcessDate | 半角数字14桁 固定
処理日時yyyyMMddHHmmss形式 |
|
AccessID | 半角英数32桁 固定
取引ID |
|
AccessPass | 半角英数32桁 固定
取引パスワード |
|
Amount | 半角数字8桁
利用金額(振込依頼金額) |
|
Tax | 半角数字7桁
税送料(振込依頼金額) |
|
ClientField1 | 全半角100バイト
加盟店自由項目1 |
|
ClientField2 | 全半角100バイト
加盟店自由項目2 |
|
ClientField3 | 全半角100バイト
加盟店自由項目3 |
|
PayType | 半角数字2桁
決済方法23:銀行振込(バーチャル口座) |
|
VaExpireDate | 半角数字8桁 固定
振込有効期限yyyMMdd形式 |
|
VaTradeReason | 全半角64バイト
振込事由振込依頼内容を返却します。 |
|
VaTradeClientName | 全半角64バイト
振込依頼先氏名
|
|
VaTradeClientMailaddress | 半角英数記号256桁
振込依頼先メールアドレス
|
|
VaAccountNumber | 半角数字7桁
口座番号 |
|
VaBankCode | 半角数字4桁
銀行コード |
|
VaBankName | 全半角45バイト
銀行名 |
|
VaBranchCode | 半角数字3桁
支店コード |
|
VaBranchName | 全半角45バイト
支店名 |
|
VaAccountType | 半角数字1桁 固定
預金種別 |
|
VaReserveID | 半角英数記号32桁
継続口座ID
|
|
VaInInquiryNumber | 半角数字8桁
照会番号銀行から返された照会番号を返却します。 |
|
VaInSettlementDate | 半角数字8桁 固定
勘定日yyyyMMdd形式 |
|
VaInAmount | 半角数字8桁
入金金額
|
|
VaInClientName | 半角144バイト
振込依頼人名
|
|
VaRequestAmount | 半角数字16桁
振込要求金額
|
|
VaInClientCode | 半角数字10桁
振込依頼人コード振込時に「依頼人名」に入力するコードを返却します。 |
|
VaInSummary | 全半角60バイト
摘要
|
|
VaTradeCode | 半角数字7桁
振込コード
|
レスポンスパラメータ:正常系
Status=TRANSFERRED&ProcessDate=20220801121212&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=23&VaExpireDate=20220801&VaTradeReason=振込事由&VaTradeClientName=山田太郎&VaTradeClientMailaddress=test@example.com&VaAccountNumber=1234567&VaBankCode=9998&VaBankName=テスト銀行&VaBranchCode=999&VaBranchName=テスト支店&VaAccountType=1&VaReserveID=12345&VaInInquiryNumber=12345&VaInSettlementDate=20220801&VaInAmount=100&VaInClientName=山田太郎&VaRequestAmount=100&VaInClientCode=12345&VaInSummary=摘要&VaTradeCode=TEST&ErrCode=&ErrInfo=
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001